Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOCS-1468: Add use case for building a simple machine #2343

Merged
merged 3 commits into from
Dec 20, 2023

Conversation

JessamyT
Copy link
Collaborator

No description provided.

@viambot viambot added the safe to build This pull request is marked safe to build from a trusted zone label Dec 19, 2023
@viambot
Copy link
Member

viambot commented Dec 19, 2023

Overall readability score: 56.35 (🔴 -0.2)

File Readability
_index.md 62.25 (🔴 -2.23)
configure.md 27.45 (🔴 -72.55)
View detailed metrics

🟢 - Shows an increase in readability
🔴 - Shows a decrease in readability

File Readability FRE GF ARI CLI DCRS
_index.md 62.25 44.03 9.76 12.4 11.6 6.41
  🔴 -2.23 🔴 -8.57 🔴 -0.03 🔴 -0.3 🔴 -0.23 🟢 +0
configure.md 27.45 32.22 13.35 22 17.11 7.96
  🔴 -72.55 🔴 -67.78 🔴 -7.35 🔴 -16 🔴 -11.11 🔴 -3.06

Averages:

  Readability FRE GF ARI CLI DCRS
Average 56.35 48.31 10.52 12.96 11.94 7.66
  🔴 -0.2 🔴 -0.22 🔴 -0.02 🔴 -0.04 🔴 -0.03 🔴 -0.01
View metric targets
Metric Range Ideal score
Flesch Reading Ease 100 (very easy read) to 0 (extremely difficult read) 60
Gunning Fog 6 (very easy read) to 17 (extremely difficult read) 8 or less
Auto. Read. Index 6 (very easy read) to 14 (extremely difficult read) 8 or less
Coleman Liau Index 6 (very easy read) to 17 (extremely difficult read) 8 or less
Dale-Chall Readability 4.9 (very easy read) to 9.9 (extremely difficult read) 6.9 or less


{{< cards >}}
{{% card link="/get-started/try-viam/" %}}
{{% card link="/tutorials/get-started/lazy-susan/" %}}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
{{% card link="/tutorials/get-started/lazy-susan/" %}}

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thought this or mouse mover would be a good example of a very simple machine that moves things instead of just blinking the led--what's your thought? Is there another one you'd recommend replacing this with?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just think 4 is a bit much so that's why I tried to eliminate one but ok to keep 4. I don't feel that strongly

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

okay i like the 4 because then they make a nice square instead of an upside-down L shape (depending on screen width) and they're all different so I think I'll leave as-is if that's ok!

Copy link
Collaborator

@npentrel npentrel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excellent work, I think this really shows extremely well how to go about building a smart machine and provides context and explanation at each step. Really well done! ✨

@viambot
Copy link
Member

viambot commented Dec 20, 2023

You can view a rendered version of the docs from this PR at https://docs-test.viam.dev/2343

@JessamyT JessamyT merged commit df93b77 into viamrobotics:main Dec 20, 2023
10 checks passed
@JessamyT JessamyT deleted the 1468simple branch December 20, 2023 20:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
safe to build This pull request is marked safe to build from a trusted zone
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants